Management API
Base Resource URL:
https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]
Description:
Provides access to configuration settings for the specified customer.
Available sub-resources:
| Resource URL | Description |
|---|---|
| https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[payment-options] | Provides access to payment options associated with the specified customer. |
| https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[subscriptions] | Allows to manage the subscriptions associated with the specified customer. |
| https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[transactions] | Provides access to the transactions associated with the specified customer. |
Supported Actions:
load
modify
Parameters:
| Method: GET | Implicit: Yes | Returns: Customer * |
| Consumes: xurl | Produces: json, xml | |
|
Returns configuration settings for the selected customer.
|
||
modify
| Method: POST | Implicit: Yes | Returns: Customer * |
| Consumes: json, xml | Produces: json, xml | |
|
Updates the selected customer with the specified values.
|
||
Parameters:
| # | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 01 | object | Customer * | Yes |
Represents information about the customer. |
Copyright ©
TidyPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.